Add health check to Directus service in Docker Compose example#615
Merged
bryantgillespie merged 6 commits intodirectus:mainfrom Apr 23, 2026
Merged
Conversation
|
@mvanhorn is attempting to deploy a commit to the Directus Team on Vercel. A member of the Team first needs to authorize it. |
Add a healthcheck configuration to the directus service block and a section explaining the /server/health and /server/ping endpoints. This helps users who run other containers that need to wait for Directus. Fixes directus#331
mvanhorn
force-pushed
the
docs/add-directus-health-check
branch
from
f9542ce to
721a71d
Compare
Member
There was a problem hiding this comment.
Nice addition. One correction on the Well that's not right either. I think the original wording you had for that part is fine for this./server/health bullet — 503 is only returned when status is error. A warn status (which is what a missing email transport actually produces) still returns 200, so the current wording contradicts itself.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Author
|
Thanks for landing the health check example, @bryantgillespie. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
healthcheckto the Directus service in the Docker Compose example and a short section explaining the two health endpoints.The compose example already had health checks for Postgres and Redis but not for Directus itself. Other containers in the stack can now use
depends_on: { directus: { condition: service_healthy } }to wait for Directus.Also documents the difference between
/server/health(checks dependencies) and/server/ping(HTTP-only), based on the discussion in #331.Fixes #331
This contribution was developed with AI assistance (Claude Code).